<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_hdmitxss1: xv_hdmitxss1_frl.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_hdmitxss1
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xv__hdmitxss1__frl_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xv_hdmitxss1_frl.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This is main header file of the Xilinx HDMI TX Subsystem driver. </p>
<p><b>HDMI Transmitter Subsystem Overview</b></p>
<p>HDMI TX Subsystem is a collection of IP cores bounded together by software to provide an abstract view of the processing pipe. It hides all the complexities of programming the underlying cores from end user.</p>
<p><b>Subsystem Driver Features</b></p>
<p>HDMI Subsystem supports following features</p>
<ul>
<li>AXI Stream Input/Output interface</li>
<li>1, 2 or 4 pixel-wide video interface</li>
<li>8/10/12/16 bits per component</li>
<li>RGB &amp; YCbCr color space</li>
<li>Up to 4k2k 60Hz resolution at both Input and Output interface</li>
<li>Interlaced input support (1080i 50Hz/60Hz)</li>
</ul>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
</p>
<hr/>
<p>
1.00  EB   22/05/18 Initial release.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a442071396c6b3e0f45197c66714e909d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__hdmitxss1__frl_8h.html#a442071396c6b3e0f45197c66714e909d">HDMITXSS1_FRL_H</a></td></tr>
<tr class="memdesc:a442071396c6b3e0f45197c66714e909d"><td class="mdescLeft">&#160;</td><td class="mdescRight">&lt; prevent circular inclusions by using protection macros  <a href="#a442071396c6b3e0f45197c66714e909d">More...</a><br/></td></tr>
<tr class="separator:a442071396c6b3e0f45197c66714e909d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:adcab49b33616b0b9d2012ac7b6966029"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__hdmitxss1__frl_8h.html#adcab49b33616b0b9d2012ac7b6966029">XV_HdmiTxSs1_FrlConfigCallback</a> (void *CallbackRef)</td></tr>
<tr class="memdesc:adcab49b33616b0b9d2012ac7b6966029"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is called when the FRL link training requires configuration from application.  <a href="#adcab49b33616b0b9d2012ac7b6966029">More...</a><br/></td></tr>
<tr class="separator:adcab49b33616b0b9d2012ac7b6966029"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9030607de0dd6b09bf6a6ee325a4b76"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__hdmitxss1__frl_8h.html#ac9030607de0dd6b09bf6a6ee325a4b76">XV_HdmiTxSs1_FrlFfeCallback</a> (void *CallbackRef)</td></tr>
<tr class="memdesc:ac9030607de0dd6b09bf6a6ee325a4b76"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is called when the FRL link training requires configuring of FFE.  <a href="#ac9030607de0dd6b09bf6a6ee325a4b76">More...</a><br/></td></tr>
<tr class="separator:ac9030607de0dd6b09bf6a6ee325a4b76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af71d9402da009b2232c6f0e7d45174d5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__hdmitxss1__frl_8h.html#af71d9402da009b2232c6f0e7d45174d5">XV_HdmiTxSs1_FrlStartCallback</a> (void *CallbackRef)</td></tr>
<tr class="memdesc:af71d9402da009b2232c6f0e7d45174d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is called when the FRL link training passes and sink is ready to receive video, audio and control packets.  <a href="#af71d9402da009b2232c6f0e7d45174d5">More...</a><br/></td></tr>
<tr class="separator:af71d9402da009b2232c6f0e7d45174d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7fb8a4318a026c390d69a8f30b019bec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__hdmitxss1__frl_8h.html#a7fb8a4318a026c390d69a8f30b019bec">XV_HdmiTxSs1_FrlStopCallback</a> (void *CallbackRef)</td></tr>
<tr class="memdesc:a7fb8a4318a026c390d69a8f30b019bec"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is called when sink requested for FRL to be stopped.  <a href="#a7fb8a4318a026c390d69a8f30b019bec">More...</a><br/></td></tr>
<tr class="separator:a7fb8a4318a026c390d69a8f30b019bec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7e151cc4c1da01d3b581db188725f12"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__hdmitxss1__frl_8h.html#af7e151cc4c1da01d3b581db188725f12">XV_HdmiTxSs1_TmdsConfigCallback</a> (void *CallbackRef)</td></tr>
<tr class="memdesc:af7e151cc4c1da01d3b581db188725f12"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is called when during FRL link training, it is decided to fallback to the legacy HDMI TMDS mode.  <a href="#af7e151cc4c1da01d3b581db188725f12">More...</a><br/></td></tr>
<tr class="separator:af7e151cc4c1da01d3b581db188725f12"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a442071396c6b3e0f45197c66714e909d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define HDMITXSS1_FRL_H</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>&lt; prevent circular inclusions by using protection macros </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="adcab49b33616b0b9d2012ac7b6966029"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HdmiTxSs1_FrlConfigCallback </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackRef</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is called when the FRL link training requires configuration from application. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___hdmi_tx_ss1.html#a5c4558f7affac06ca35573c3b6338c8a">XV_HdmiTxSs1::FrlConfigCallback</a>, <a class="el" href="struct_x_v___hdmi_tx_ss1.html#a3f4668f9684b4f0d45c9e1c46ea18b38">XV_HdmiTxSs1::FrlConfigRef</a>, <a class="el" href="xv__hdmitxss1_8h.html#a3235ae792b21ddbc07efb7b78edde194afc70a2fee8b8c6a16bd55a994ecdf9a2">XV_HDMITXSS1_LOG_EVT_FRL_CFG</a>, and <a class="el" href="xv__hdmitxss1_8h.html#a0c9023e762552ac6d46bddeaaa1ea40b">XV_HdmiTxSs1_LogWrite()</a>.</p>

</div>
</div>
<a class="anchor" id="ac9030607de0dd6b09bf6a6ee325a4b76"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HdmiTxSs1_FrlFfeCallback </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackRef</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is called when the FRL link training requires configuring of FFE. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___hdmi_tx_ss1.html#acde6e561dd0ef18e01cbc5d41c62bd84">XV_HdmiTxSs1::FrlFfeCallback</a>, and <a class="el" href="struct_x_v___hdmi_tx_ss1.html#a311d99862dfb32c497f68262c9c36a5e">XV_HdmiTxSs1::FrlFfeRef</a>.</p>

</div>
</div>
<a class="anchor" id="af71d9402da009b2232c6f0e7d45174d5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HdmiTxSs1_FrlStartCallback </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackRef</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is called when the FRL link training passes and sink is ready to receive video, audio and control packets. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___hdmi_tx_ss1.html#a73203cdb4c5ddcd704b656ec6b5aa90e">XV_HdmiTxSs1::FrlStartCallback</a>, <a class="el" href="struct_x_v___hdmi_tx_ss1.html#a43c978206f8628e98d3cfb71c872ed95">XV_HdmiTxSs1::FrlStartRef</a>, <a class="el" href="xv__hdmitxss1_8h.html#a3235ae792b21ddbc07efb7b78edde194ab092edcc43dc4cfafe5fdeda63c6d419">XV_HDMITXSS1_LOG_EVT_FRL_LT_PASS</a>, and <a class="el" href="xv__hdmitxss1_8h.html#a0c9023e762552ac6d46bddeaaa1ea40b">XV_HdmiTxSs1_LogWrite()</a>.</p>

</div>
</div>
<a class="anchor" id="a7fb8a4318a026c390d69a8f30b019bec"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HdmiTxSs1_FrlStopCallback </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackRef</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is called when sink requested for FRL to be stopped. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___hdmi_tx_ss1.html#a85ca67e479d76e37e776073beccbfcd8">XV_HdmiTxSs1::FrlStopCallback</a>, and <a class="el" href="struct_x_v___hdmi_tx_ss1.html#afea63d8c1818c57bf1d7eb2aaccaabfc">XV_HdmiTxSs1::FrlStopRef</a>.</p>

</div>
</div>
<a class="anchor" id="af7e151cc4c1da01d3b581db188725f12"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HdmiTxSs1_TmdsConfigCallback </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackRef</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is called when during FRL link training, it is decided to fallback to the legacy HDMI TMDS mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___hdmi_tx_ss1.html#a88bbd5a97e7a01a235d925f69edd6822">XV_HdmiTxSs1::TmdsConfigCallback</a>, <a class="el" href="struct_x_v___hdmi_tx_ss1.html#a8d892935990ad343a02e62039708ba32">XV_HdmiTxSs1::TmdsConfigRef</a>, <a class="el" href="xv__hdmitxss1_8h.html#a3235ae792b21ddbc07efb7b78edde194a521bdc151a83e9587a1d73afbc691502">XV_HDMITXSS1_LOG_EVT_TMDS_START</a>, and <a class="el" href="xv__hdmitxss1_8h.html#a0c9023e762552ac6d46bddeaaa1ea40b">XV_HdmiTxSs1_LogWrite()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
